Documentation and Setup Improvements #119
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
devanshjainms
requested review from
Copilot,
nnoaman,
KimForss and
hdamecharla
and removed request for
Copilot
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull Request Overview
This pull request introduces significant improvements to documentation and project onboarding, along with major refactoring of the HA cluster validation system. The key changes modernize the constants structure, implement a new validation approach, and enhance the overall developer experience.
- Refactored HA validation logic from CIB-first to constants-first approach with tuple-based expected values
- Added comprehensive project documentation including Copilot instructions and dedicated setup guide
- Updated constants structure to include required/optional parameter flags for better validation control
Reviewed Changes
Copilot reviewed 18 out of 33 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/modules/get_pcmk_properties_scs_test.py | Updated test constants and assertions to match new tuple-based validation format |
| tests/modules/get_pcmk_properties_db_test.py | Modified test data structure and expectations for new validation system |
| tests/module_utils/get_pcmk_properties_test.py | Aligned test methods with refactored parameter status determination logic |
| src/vars/input-api.yaml | Enabled offline validation tests for both SCS and DB components |
| src/templates/report.html | Updated warning color scheme from yellow to orange for better visibility |
| src/roles/ha_scs/tasks/files/constants.yaml | Restructured configuration constants with value/required flags |
| src/roles/ha_db_hana/tasks/files/constants.yaml | Applied new constants structure with explicit required parameter definitions |
| src/modules/get_pcmk_properties_scs.py | Implemented new validation logic and offline validation support |
| src/modules/get_pcmk_properties_db.py | Added constants-first validation with HANA-specific logic |
| src/module_utils/sap_automation_qa.py | Removed unused Optional import |
| src/module_utils/get_pcmk_properties.py | Major refactor from CIB-first to constants-first validation approach |
| src/ansible.cfg | Changed stdout callback from yaml to default |
| scripts/setup.sh | Added Azure CLI installation and updated dependency management |
| docs/high_availability/*.md | Fixed relative link paths for better navigation |
| docs/SETUP.MD | Created comprehensive setup guide with technical requirements |
| docs/HIGH_AVAILABILITY.md | Streamlined by removing setup instructions and referencing new guide |
| .github/copilot-instructions.md | Added detailed project context and coding partnership guidelines |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Bumps [pandas](https://github.com/pandas-dev/pandas) from 2.3.1 to 2.3.3. - [Release notes](https://github.com/pandas-dev/pandas/releases) - [Commits](pandas-dev/pandas@v2.3.1...v2.3.3) --- updated-dependencies: - dependency-name: pandas dependency-version: 2.3.3 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Devansh Jain <86314060+devanshjainms@users.noreply.github.com>
mkdeegan
previously approved these changes
Oct 1, 2025
…elay (#122) * Add provider value resolution and enhance parameter status determination logic * Refactor cluster parameter retrieval logic and update related tests * Refactor command imports and update cluster status retrieval logic to use new parameters * Refactor HANA resource handling by renaming parameters and updating related logic across multiple files * Refactor command execution logic to simplify parameter value retrieval * Fix typo in method name and update related test cases for cluster parameter retrieval * Fix inconsistent quote style in test case for cluster parameter retrieval * Update cluster parameter retrieval to include PRIORITY_FENCING_DELAY and fix typo in test case name
mkdeegan
approved these changes
Oct 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces significant improvements to documentation and project onboarding for the SAP Testing Automation Framework. The main changes include the addition of a comprehensive Copilot instructions file, a refactor of the high availability documentation to streamline setup guidance, and the creation of a dedicated setup guide. There are also minor corrections to file paths and naming for clarity.
Documentation and Onboarding Improvements
Added a new
.github/copilot-instructions.mdfile that provides detailed project context, coding partnership rules, enterprise-grade defaults, and specific guidance for contributors, ensuring clarity and consistency for new developers and Copilot usage.Refactored
docs/HIGH_AVAILABILITY.mdto remove technical requirements and setup instructions, replacing them with a reference to the new setup guide for a more maintainable and streamlined onboarding process. [1] [2]Created a new
docs/SETUP.MDfile with expanded technical requirements, step-by-step environment setup instructions, and details on Azure RBAC, network connectivity, and analytics integration, consolidating all onboarding information in one place.File Structure and Path Corrections
docs/DB_HIGH_AVAILABILITY.mdtodocs/high_availability/DB_HIGH_AVAILABILITY.mdand corrected relative links to Ansible task files for improved clarity and navigation.